SftTree/OCX 7.0

SftTree.GetCellColorSample Method

Softel vdm, Inc.

Defines the color sample displayed as an item's cell graphic.

Deprecated - Provided for compatibility with earlier versions only - Use Cell.Image.GetColorSample instead

Syntax       

VB.NET

object.GetCellColorSample(ByVal ItemIndex As Integer, ByVal ColIndex As Short, ByRef Clr As System.Drawing.ColorLanguage-specific information, ByRef FrameClr As System.Drawing.ColorLanguage-specific information, ByRef WidthPix As Short, ByRef HeightPix As Short)

VB

object.GetCellColorSample(ByVal ItemIndex As Long, ByVal ColIndex As Integer, Clr As OLE_COLOR, FrameClr As OLE_COLOR, WidthPix As Integer, HeightPix As Integer)

C#.NET

void object.GetCellColorSample(int ItemIndex, short ColIndex, out System.Drawing.ColorLanguage-specific information Clr, out System.Drawing.ColorLanguage-specific information FrameClr, out short WidthPix, out short HeightPix);

VC++

HRESULT object->GetCellColorSample(long ItemIndex, short ColIndex, OLE_COLOR* Clr, OLE_COLOR* FrameClr, short* WidthPix, short* HeightPix);

C

HRESULT object->raw_GetCellColorSample(long ItemIndex, short ColIndex, OLE_COLOR* Clr, OLE_COLOR* FrameClr, short* WidthPix, short* HeightPix);

Delphi

procedure object.GetCellColorSample(ItemIndex : Integer, ColIndex : Smallint, out Clr : TColor, out FrameClr : TColor, out WidthPix : Smallint, out HeightPix : Smallint);

object

A SftTree object.

ItemIndex

The zero-based index of the item.  The combination of ItemIndex and ColIndex describes an individual cell.

ColIndex

The zero-based column number.  The combination of ItemIndex and ColIndex describes an individual cell.

Clr

Returns the color value used to fill the color sample rectangle.

FrameClr

Returns the color value used to outline the color sample rectangle.

WidthPix

Returns the width of the color sample rectangle in pixels.

HeightPix

Returns the height of the color sample rectangle in pixels.

Comments

Deprecated - Provided for compatibility with earlier versions only - Use Cell.Image.GetColorSample instead

The GetCellColorSample method defines the color sample displayed as an item's cell graphic.

See Also  SftTree Object | Object Hierarchy


Feedback / comments / error reports for this topic
© 2015 - Softel vdm, Inc. - www.softelvdm.com